API Documentation
Static Public Member Functions | List of all members
nkAstraeus::EffectTypeUtils Class Referencefinal

Offers utility functions to help with the enumeration support. More...

Static Public Member Functions

static nkMemory::StringView enumToString (EFFECT_TYPE value)
 
static EFFECT_TYPE stringToEnum (const nkMemory::StringView &value)
 

Detailed Description

Offers utility functions to help with the enumeration support.

Member Function Documentation

◆ enumToString()

static nkMemory::StringView nkAstraeus::EffectTypeUtils::enumToString ( EFFECT_TYPE  value)
static

Translates an enum value to a string. Values supported are :

Enum value String value
EFFECT_TYPE::UNKNOWN 'UNKNOWN'
EFFECT_TYPE::FILM_GRAIN 'FILM_GRAIN'
EFFECT_TYPE::FXAA 'FXAA'
EFFECT_TYPE::SSAO 'SSAO'
EFFECT_TYPE::TEXTURE_COPY 'TEXTURE_COPY'
Parameters
valueThe enumeration value to convert.
Returns
The enumeration value name as a string.

◆ stringToEnum()

static EFFECT_TYPE nkAstraeus::EffectTypeUtils::stringToEnum ( const nkMemory::StringView value)
static

Translates a string to its enum value.

String value Enum value
'FILM_GRAIN' EFFECT_TYPE::FILM_GRAIN
'FXAA' EFFECT_TYPE::FXAA
'SSAO' EFFECT_TYPE::SSAO
'TEXTURE_COPY' EFFECT_TYPE::TEXTURE_COPY
'UNKNOWN' / Anything else EFFECT_TYPE::UNKNOWN'
Parameters
valueThe string to convert.
Returns
The enumeration value identified.

The documentation for this class was generated from the following file: